docs(readme): truth the README to match the actual binary#43
Merged
Conversation
Remove claims the built binary does not implement (init scaffolding, serve/live-reload, compile-time template validation, schema-enforced frontmatter, incremental rebuilds, asset hash cache-busting). Describe the real CLI (build <in> [out] / clean / --version, --drafts, --no-clean-urls) and the actual feature set, and surface the genuine differentiators that were omitted: accessibility-by-construction (accessible default theme, auto th scope, FlexiText alt-text-required) and the Gnosis metadata layer ((:placeholder), DAX, badges). Separate implemented vs planned; link ADR-0001 for engine direction. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WN6nPWWe4dvXfoqBG6auWN
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
hyperpolymath
marked this pull request as ready for review
June 23, 2026 20:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Aligns
README.adocwith what the built binary (CasketGnosis.hs) actually does — the first cheap slice from ADR-0001's "ship honest first" sequencing.Removed claims the binary does not implement:
casket-ssg initscaffolding andcasket-ssg serve/ live-reload (the CLI isbuild <in> [out]/clean/--version)key: valueparser)Surfaced the real differentiators the old README omitted:
scope="col"on table headers (WCAG 1.3.1), andFlexiTextmaking empty alt-text a constructor error.(:placeholder)substitution,{{#if}}/{{#for}}(DAX), Shields badges from typed metadata.Also: documented the real CLI + flags (
--drafts,--no-clean-urls,CASKET_DRAFTS), separated Implemented vs Planned, set Status: alpha, and linked ADR-0001 for the engine direction.Notes
mainreds (PandocHighlightMethodbuild break; the 18 Hypatia findings) — neither introduced here.🤖 Generated with Claude Code
https://claude.ai/code/session_01WN6nPWWe4dvXfoqBG6auWN
Generated by Claude Code